ESEFolder

The ESEFolder class represents an ESE folder. Folders can exist within the catalog and other folders. They contain other folders and services. Objects of this type can be used to introspect the catalog-folder-service hierarchy.

Methods

• ESEFolder::GetChild
• ESEFolder::GetChildren
• ESEFolder::GetParent

Example

Retrieve a subfolder within a folder of the catalog:

Server = ESE.GetServer( 'localhost', 8181 )

Catalog = Server.GetCatalog()

Folder = Catalog.GetChild( 'Filters' )

SubFolder = Folder.GetChild( 'Frequency' )

Properties

NAME (Get)

The name of the folder.

URI (Get)

The full URI to the folder from the ESE installation.

ESEFolder::GetChild

This function returns either an ESEFolder or ESEService object matching the specified name. The search is case insensitive.

Example

In this example a folder object is used to explicitly get a child service:

Server = ESE.GetServer( 'localhost', 8181 )

Catalog = Server.GetCatalog()

Folder1 = Catalog.GetChild( 'Filters' )

Folder2 = Folder1.GetChild( 'Adaptive' )

Service = Folder2.GetChild( 'LocalSigma' )

Syntax

Result = Obj.[ESEFolder::]GetChild( Name )

Return Value

This method returns the child object that matches the supplied name. The match is case insensitive. If the name does not match any children then !NULL is returned.

Arguments

Name

The name of the ESEFolder or ESEService.

Keywords

None.

ESEFolder::GetChildren

This function returns an IDL list of objects for all the folders, services, or both, contained directly by the folder.

Example

Server = ESE.GetServer( 'localhost', 8181 )

Catalog = Server.GetCatalog()

Folder = Catalog.GetChild( 'Filters' )

SubFolders = Folder.GetChildren( /FOLDERS, /SORT)

Services = Folder.GetChildren( /SERVICES, /SORT)

Syntax

Result = Obj.[ESEFolder::]GetChildren( [, /FOLDERS] [, /SERVICES] [, /SORT] )

Return Value

This method returns an IDL list of ESEFolder and ESEService objects. By default, folders are ordered first. If no children exist then an empty list is returned. If just the FOLDERS keyword is set, then only folders are returned. Similarly, if just the SERVICES keyword is set, then only services are returned. The SORT keyword returns the list sorted alphabetically. This function throws an error if there is an IDLnetURL error.

Arguments

None.

Keywords

FOLDERS

Set this keyword to return ESEFolder objects. If the SERVICES keyword is not set, then only folders are returned.

SERVICES

Set this keyword to return ESEService objects. If the FOLDERS keyword is not set, then only services are returned.

SORT

Set this keyword to alphabetically sort the list of folders and services.

ESEFolder::GetParent

This function returns the ESEServer or ESEFolder object in which this folder resides.

Example

Server = ESE.getServer( 'localhost', 8181 )

Catalog = Server.GetCatalog()

Folder = Catalog.GetFolder( 'Filters' )

Parent = Folder.GetParent() ; Parent should be the same as Catalog

Syntax

Result = Obj.[ESEFolder::]GetParent( )

Return Value

Returns the ESEServer object in which this folder resides

Arguments

None.

Keywords

None.

Version History

See Also

ESE, ESEService